Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Action to Create Package Wiki #1197

Merged
merged 3 commits into from
Jan 10, 2025
Merged

Add GitHub Action to Create Package Wiki #1197

merged 3 commits into from
Jan 10, 2025

Conversation

emtuls
Copy link
Member

@emtuls emtuls commented Dec 11, 2024

This partially resolves #1107 by creating a wiki page that contains a table of tools for each category and is updated daily.

Part 2 will be a second PR.

@emtuls emtuls added 💎 enhancement It is working, but it could be better 🌀 FLARE-VM A package or feature to be used by FLARE-VM labels Dec 11, 2024
@emtuls emtuls self-assigned this Dec 11, 2024
@emtuls emtuls requested a review from Ana06 December 11, 2024 05:24
Copy link
Member

@Ana06 Ana06 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emtuls where have you tested the action? Can you please provide a link to a run of the action and a wiki example page?

.github/workflows/generate_package_wiki.yml Outdated Show resolved Hide resolved
@emtuls emtuls force-pushed the package-wiki branch 2 times, most recently from 408dae7 to d2667ca Compare December 12, 2024 04:04
@emtuls
Copy link
Member Author

emtuls commented Dec 12, 2024

I've updated the script as per your suggestion and have the run and wiki example on my fork:

Run - https://github.com/emtuls/VM-Packages/actions/runs/12289627139/job/34295427884
Wiki - https://github.com/emtuls/VM-Packages/wiki/Packages

Copy link
Member

@Ana06 Ana06 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sharing the run and the wiki example page @emtuls!! 🚀

.github/workflows/generate_package_wiki.yml Outdated Show resolved Hide resolved
.github/workflows/generate_package_wiki.yml Outdated Show resolved Hide resolved
.github/workflows/generate_package_wiki.yml Outdated Show resolved Hide resolved
@emtuls
Copy link
Member Author

emtuls commented Dec 13, 2024

I've made the adjustments you suggested, which can be seen here:
Wiki - https://github.com/emtuls/VM-Packages/wiki/Packages
GitHub Action Run - https://github.com/emtuls/VM-Packages/actions/runs/12308409152


- name: Generate Wiki Content
id: generate-content
shell: pwsh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think powershell is the default for windows and this can be deleted. Or am I missing something? 🤔

Suggested change
shell: pwsh

runs-on: windows-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should you should pin your GitHub Actions by commit-hash: https://blog.rafaelgss.dev/why-you-should-pin-actions-by-commit-hash (also few lines below)

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

$packagesByCategory = @{}

foreach ($package in $packages) {
$categoryFile = "$packagesDir/$package/tools/chocolateyinstall.ps1"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] there are some indentation inconsistencies here

@Ana06
Copy link
Member

Ana06 commented Jan 9, 2025

I think @emtuls does not have time to address the feedback, I'll add a commit to this PR to address it so that we can merge it.

emtuls and others added 3 commits January 9, 2025 18:28
- Pin `actions/checkout` GitHub Action by commit-hash
- Remove unneeded shell tag, as it was set to the default
- Explain why `git add .` is needed
@Ana06 Ana06 requested a review from sara-rn January 9, 2025 17:52
@Ana06 Ana06 merged commit 2460c4e into main Jan 10, 2025
6 checks passed
@Ana06 Ana06 modified the milestone: FLARE-VM 2024 Q4 Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌀 FLARE-VM A package or feature to be used by FLARE-VM 💎 enhancement It is working, but it could be better
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move the categories to the nuspec & Add wiki page with tools by categories
2 participants